docs: make Helm the primary install method on ClickStack OTel collector page#115
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: make Helm the primary install method on ClickStack OTel collector page#115mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Ports ClickHouse/clickhouse-docs#6337 — reorganises the ClickStack OTel collector page so Helm is the primary install path, with Docker preserved in secondary tabs.
Changes
values.yamlexample pinned todocker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0.#configuring-managed-clickstack,#configuring-clickhouse-instance).OTLP_AUTH_TOKEN(viaextraEnvs) under Securing the collector for the Managed ClickStack tab./products/clickstack/deployment/helm.Context
Helm is the recommended install method for Kubernetes and matches how the ClickStack Helm chart ships the collector (as a subchart of the upstream
opentelemetry-collectorchart).Notes on the Docusaurus → Mintlify port
<Tabs groupId="install-method">/<TabItem value="…" label="…" default>to Mintlify<Tabs>/<Tab title="…">. MintlifyTabhas nodefaultprop — the firstTab(Helm) is shown first, matching intent. Mintlify also has nogroupId, so the install-method tabs are no longer linked across sections; this is the expected mapping.Note
Low Risk
Documentation-only changes to deployment instructions; no application code, auth logic, or data paths are modified.
Overview
The ClickStack OTel collector doc (
collector.mdx) is reorganized so Helm is the primary install path for Kubernetes, with Docker kept in a second tab in the same sections.For both Managed and Open Source flows, Deploying the collector now opens with Helm vs Docker nested tabs: Helm adds the upstream
opentelemetry-collectorchart repo, avalues.yamlusingdocker.clickhouse.com/clickhouse/clickstack-otel-collector:2.19.0, OTLP ports, andextraEnvs(Managed: Cloud endpoint/credentials; OSS: ClickHouse,OPAMP_SERVER_URL,HYPERDX_API_KEY), plus guidance to use secrets viaextraEnvsFrom. Docker content is unchanged but moved under the Docker tab; shared env-var notes sit below the tabs.Modifying configuration for Managed and OSS is split the same way: Helm shows
extraEnvsoverrides andhelm upgrade; Docker keeps export/docker runexamples.Under Securing the collector (Managed only),
OTLP_AUTH_TOKENvia HelmextraEnvsis documented alongside the existing Docker flow. The Open Source securing section is untouched.Intro copy links the ClickStack Helm chart, upstream OTel Helm chart, and
/products/clickstack/deployment/helm. Existing anchor IDs are preserved; Mintlify has no cross-section tabgroupId, so install-method tabs are independent per section.Reviewed by Cursor Bugbot for commit 30abb34. Bugbot is set up for automated code reviews on this repo. Configure here.